Pular para o conteúdo

/v1/domains/{domainId}/users/invitations

Requisição

Create a user invitation

Segurança
httpAuth
Caminho
domainIdstring, (uuid)obrigatório
Corpo
userobjectobrigatório
numberSecondsOfValidityinteger, (int32), [ 0 .. 2147483647 ]obrigatório
curl -i -X POST \
  'https://docs.ripple.com/_mock/pt-br/products/custody/v1.34/devbox/v1/domains/{domainId}/users/invitations' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "alias": "string",
      "customProperties": {
        "property1": "string",
        "property2": "string"
      },
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "lock": "Unlocked",
      "roles": [
        "string"
      ]
    },
    "numberSecondsOfValidity": 0
  }'

Respostas

OK

Corpo
idstring, (uuid)obrigatório
codestringobrigatório
statusstringobrigatório
Enum:"Pending""DeviceRegistered""Expired""Cancelled""Completed"
validUntilstring, (date-time)obrigatório
userobjectobrigatório
metadataobjectobrigatório
Resposta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "string",
  "status": "Pending",
  "validUntil": "2019-08-24T14:15:22Z",
  "user": {
    "alias": "string",
    "customProperties": { … },
    "description": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",
    "lock": "Unlocked",
    "roles": [ … ],
    "publicKey": "string"
  },
  "metadata": {
    "createdAt": "2019-08-24T14:15:22Z",
    "lastModifiedAt": "2019-08-24T14:15:22Z",
    "createdBy": { … }
  }
}